Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(graphql): Add sorting option to single-entity search GraphQL API #11315

Closed
wants to merge 25 commits into from
Closed

feat(graphql): Add sorting option to single-entity search GraphQL API #11315

wants to merge 25 commits into from

Conversation

Sukeerthi31
Copy link
Contributor

@Sukeerthi31 Sukeerthi31 commented Sep 6, 2024 •
edited
Loading

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added product PR or Issue related to the DataHub UI/UX devops PR or Issue related to DataHub backend & deployment community-contribution PR or Issue raised by member(s) of DataHub Community labels Sep 6, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 6, 2024 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Sukeerthi31 Sukeerthi31 changed the title Graphql sort feat(graphql): Add sorting option to GraphQL search at the entity level Sep 7, 2024
@Sukeerthi31 Sukeerthi31 changed the title feat(graphql): Add sorting option to GraphQL search at the entity level feat(graphql): Add sorting option to single-entity search GraphQL API Sep 7, 2024
@Sukeerthi31 Sukeerthi31 marked this pull request as ready for review September 9, 2024 05:21
@RyanHolstien
Copy link
Collaborator

What's the use case here for using this search path? This function is a likely candidate for deprecation and API calls should utilize searchAcrossEntities which is the main search endpoint our product uses. For a single entity you can specify which entity to search across in searchAcrossEntities if you need it to be targeted.

@Sukeerthi31
Copy link
Contributor Author

What's the use case here for using this search path? This function is a likely candidate for deprecation and API calls should utilize searchAcrossEntities which is the main search endpoint our product uses. For a single entity you can specify which entity to search across in searchAcrossEntities if you need it to be targeted.

We have some custom pages built that use the search endpoint instead of the searchAcrossEntities. These changes were a part of this PR previously - Add sorting option to GraphQL search , which I have refined based on the current upstream functionalities and tests. Also could you please let us know the reason for the deprecating the single-entity search API.

@RyanHolstien
Copy link
Collaborator

What's the use case here for using this search path? This function is a likely candidate for deprecation and API calls should utilize searchAcrossEntities which is the main search endpoint our product uses. For a single entity you can specify which entity to search across in searchAcrossEntities if you need it to be targeted.

We have some custom pages built that use the search endpoint instead of the searchAcrossEntities. These changes were a part of this PR previously - Add sorting option to GraphQL search , which I have refined based on the current upstream functionalities and tests. Also could you please let us know the reason for the deprecating the single-entity search API.

It is not really maintained, its functionality is a subset of that provided by searchAcrossEntities and that is the endpoint that continues to receive updates to functionality. We would rather not maintain multiple endpoints with the same functionality.

@Sukeerthi31
Copy link
Contributor Author

What's the use case here for using this search path? This function is a likely candidate for deprecation and API calls should utilize searchAcrossEntities which is the main search endpoint our product uses. For a single entity you can specify which entity to search across in searchAcrossEntities if you need it to be targeted.

We have some custom pages built that use the search endpoint instead of the searchAcrossEntities. These changes were a part of this PR previously - Add sorting option to GraphQL search , which I have refined based on the current upstream functionalities and tests. Also could you please let us know the reason for the deprecating the single-entity search API.

It is not really maintained, its functionality is a subset of that provided by searchAcrossEntities and that is the endpoint that continues to receive updates to functionality. We would rather not maintain multiple endpoints with the same functionality.

Alright, that makes sense. Thank you for the clarification, I guess we can close this PR since these changes would anyway be temporary due to deprecation, we can work towards utilising the searchAcrossEntities endpoint across our project for future compatibility with upstream.

@Sukeerthi31
Copy link
Contributor Author

Closing this PR owing to the discussion above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@RyanHolstien RyanHolstien

Labels
community-contribution PR or Issue raised by member(s) of DataHub Community devops PR or Issue related to DataHub backend & deployment product PR or Issue related to the DataHub UI/UX
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Sukeerthi31 @RyanHolstien